/**
 * Copyright (c) 2009 blurredVision
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 * associated documentation files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, 
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or 
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT 
 * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT 
 * OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#ifndef __GUI_IHIGHLIGHTABLE_H__
#define __GUI_IHIGHLIGHTABLE_H__

#pragma once

#include "geom/Vector.h"
#include "ITexture.h"

namespace gui {

/**
 * \ingroup coreGUI
 *
 * \date 04-21-2007
 *
 * \author juckel
 *
 * \todo Insert Comments
 *
 */
class GUI_EXPORT IHighlightable
{
public:
	/// Set the text color of a highlighted element
	void setHighlightTextColor(float r, float g, float b, float a);

	/// Set the background color of a highlighted element
	void setHighlightBackColor(float r, float g, float b, float a);

	/// Set the border color of a highlighted element
	void setHighlightBorderColor(float r, float g, float b, float a);

	/// Sets the highlight state 
	void setHighlighted(bool value);

	/// Returns the highlight state. On mouse over, this is true
	bool isHighlighted() const;

	/// Sets if the component may be highlighted
	void setHighlightable(bool value);

	/// Indicates, if the component is highlightable
	bool isHighlightable() const;

	void setHighlightedIndex(int id);
	const int getHighlightedIndex() const;

	void setHighlightedBackground( ITexture* pTexture);

protected:
	// Don't create instances from IHighlightable
	IHighlightable(void);
	virtual ~IHighlightable(void);

	bool m_bHighlighted;
	bool m_bHighlightable;
	int  m_iIdHighlighted;

	math::Vector4 vHighlightTextColor;
	math::Vector4 vHighlightBackColor;
	math::Vector4 vHighlightBorderColor;
	
	ITexture *m_pHighlightedTexture;
};

} // namespace

#endif
